动态SQL
可以先写出普通的SQL语句,再在xml配置中去修改成为动态SQL实现通用。
动态 SQL 是 MyBatis 的强大特性之一。动态SQL就是在拼接SQL语句,只要保证SQL的正确性,按照SQL的格式,去排列组合即可。
可以根据不同的条件生成不同的SQL语句。
动态 SQL 元素和 JSTL 或基于类似 XML 的文本处理器相似。在 MyBatis 之前的版本中,有很多元素需要花时间了解。MyBatis 3 大大精简了元素种类,现在只需学习原来一半的元素便可。MyBatis 采用功能强大的基于 OGNL 的表达式来淘汰其它大部分元素。
- if
- choose (when, otherwise)
- trim (where, set)
- foreach
1. if
<select id="findActiveBlogWithTitleLike"
resultType="Blog">
SELECT * FROM BLOG
<if test="state != null">
AND state = #{state}
</if>
<if test="title != null">
AND title like #{title}
</if>
</select>
2. choose、when、otherwise
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG WHERE state = ‘ACTIVE’
<choose>
<when test="title != null">
AND title like #{title}
</when>
<when test="author != null and author.name != null">
AND author_name like #{author.name}
</when>
<otherwise>
AND featured = 1
</otherwise>
</choose>
</select>
3. trim、where、set
作用:匹配正确的SQL语句,去除拼接后多出的部分单词。
自定义元素trim可以定制where、set的功能。
3.1. where
<select id="findActiveBlogLike"
resultType="Blog">
SELECT * FROM BLOG
<where>
<if test="state != null">
state = #{state}
</if>
<if test="title != null">
AND title like #{title}
</if>
<if test="author != null and author.name != null">
AND author_name like #{author.name}
</if>
</where>
</select>
where 元素只会在子元素返回任何内容的情况下才插入 “WHERE” 子句。而且,若子句的开头为 “AND” 或 “OR”,where 元素也会将它们去除。
自定义where元素的功能:
<trim prefix="WHERE" prefixOverrides="AND |OR ">
...
</trim>
3.2. set
<update id="updateAuthorIfNecessary">
update Author
<set>
<if test="username != null">username=#{username},</if>
<if test="password != null">password=#{password},</if>
<if test="email != null">email=#{email},</if>
<if test="bio != null">bio=#{bio}</if>
</set>
where id=#{id}
</update>
set 元素会动态地在行首插入 SET 关键字,并会删掉额外的逗号(这些逗号是在使用条件语句给列赋值时引入的)。
自定义set元素的功能
<trim prefix="SET" suffixOverrides=",">
...
</trim>
4. foreach
对集合进行遍历(尤其是在构建 IN 条件语句的时候)
<select id="selectPostIn" resultType="domain.blog.Post">
SELECT *
FROM POST P
WHERE ID in
<foreach collection="list" item="item" index="index"
open="(" separator="," close=")">
#{item}
</foreach>
<!--where ID in (arg1, arg2, arg3)-->
</select>
list为传递的集合,item为集合中遍历出来的值,index为当前遍历的序号。
open、separator、close分别定义开始、结束和中间的分隔符。
传递的集合可以是List、Set、Map或者数组对象。
5. sql
sql脚本片段可以将一部分sql语句提取成公共片段,实现复用。
注意事项:
- 最好基于单表来定义SQL片段。
- 不要在片段中存在where、set、trim标签。此类标签应出现在原语句上。
<sql id="set-password-email-bio">
<if test="password != null">password=#{password},</if>
<if test="email != null">email=#{email},</if>
<if test="bio != null">bio=#{bio}</if>
</sql>
<update id="updateAuthorIfNecessary">
update Author
<set>
<if test="username != null">username=#{username},</if>
<include refid="set-password-email-bio" />
</set>
where id=#{id}
</update>
6. script
要在带注解的映射器接口类中使用动态 SQL,可以使用 script 元素。
@Update({"<script></script>"})
void updateAuthorValues(Author author);